<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaReportDocument: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="ch35.html" title="API reference">
<link rel="prev" href="GdaReportEngine.html" title="GdaReportEngine">
<link rel="next" href="GdaReportDocbookDocument.html" title="GdaReportDocbookDocument">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GdaReportDocument.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdaReportDocument.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#GdaReportDocument.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch35.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdaReportEngine.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaReportDocbookDocument.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdaReportDocument"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaReportDocument.top_of_page"></a>GdaReportDocument</span></h2>
<p>GdaReportDocument — Report document</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdaReportDocument.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdaReportDocument.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdaReportDocument.html#gda-report-document-set-template" title="gda_report_document_set_template ()">gda_report_document_set_template</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdaReportDocument.html#gda-report-document-run-as-html" title="gda_report_document_run_as_html ()">gda_report_document_run_as_html</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdaReportDocument.html#gda-report-document-run-as-pdf" title="gda_report_document_run_as_pdf ()">gda_report_document_run_as_pdf</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaReportDocument.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a class="link" href="GdaReportEngine.html" title="GdaReportEngine"><span class="type">GdaReportEngine</span></a> *</td>
<td class="property_name"><a class="link" href="GdaReportDocument.html#GdaReportDocument--engine" title="The “engine” property">engine</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GdaReportDocument.html#GdaReportDocument--template" title="The “template” property">template</a></td>
<td class="property_flags">Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaReportDocument.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdaReportDocument.html#GdaReportDocument-struct" title="struct GdaReportDocument">GdaReportDocument</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaReportDocument.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> GdaReportDocument
        <span class="lineart">├──</span> <a class="link" href="GdaReportRmlDocument.html" title="GdaReportRmlDocument">GdaReportRmlDocument</a>
        <span class="lineart">╰──</span> <a class="link" href="GdaReportDocbookDocument.html" title="GdaReportDocbookDocument">GdaReportDocbookDocument</a>
</pre>
</div>
<div class="refsect1">
<a name="GdaReportDocument.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libgda-report/gda-report-engine.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GdaReportDocument.description"></a><h2>Description</h2>
<p>The <a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> wraps the usage of a <a class="link" href="GdaReportEngine.html" title="GdaReportEngine"><span class="type">GdaReportEngine</span></a> for specific HTML or PDF targets. This class is
abstract (no instance be created directly), and one of its subclasses has to be used.</p>
</div>
<div class="refsect1">
<a name="GdaReportDocument.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-report-document-set-template"></a><h3>gda_report_document_set_template ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_report_document_set_template (<em class="parameter"><code><a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> *doc</code></em>,
                                  <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *file</code></em>);</pre>
<p>Instructs <em class="parameter"><code>doc</code></em>
 to use the <em class="parameter"><code>file</code></em>
 RML file as a template</p>
<div class="refsect3">
<a name="gda-report-document-set-template.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>doc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>file</p></td>
<td class="parameter_description"><p>a RML file name, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-report-document-run-as-html"></a><h3>gda_report_document_run_as_html ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_report_document_run_as_html (<em class="parameter"><code><a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> *doc</code></em>,
                                 <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
                                 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates the report document and saves it as an HTML file into <em class="parameter"><code>filename</code></em>
</p>
<div class="refsect3">
<a name="gda-report-document-run-as-html.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>doc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the name of a filename to save to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-report-document-run-as-html.returns"></a><h4>Returns</h4>
<p> TRUE if no error occurred</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-report-document-run-as-pdf"></a><h3>gda_report_document_run_as_pdf ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_report_document_run_as_pdf (<em class="parameter"><code><a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> *doc</code></em>,
                                <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates the report document and saves it as a PDF file into <em class="parameter"><code>filename</code></em>
</p>
<div class="refsect3">
<a name="gda-report-document-run-as-pdf.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>doc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaReportDocument.html" title="GdaReportDocument"><span class="type">GdaReportDocument</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>filename</p></td>
<td class="parameter_description"><p>the name of a filename to save to</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-report-document-run-as-pdf.returns"></a><h4>Returns</h4>
<p> TRUE if no error occurred</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdaReportDocument.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaReportDocument-struct"></a><h3>struct GdaReportDocument</h3>
<pre class="programlisting">struct GdaReportDocument;</pre>
</div>
</div>
<div class="refsect1">
<a name="GdaReportDocument.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GdaReportDocument--engine"></a><h3>The <code class="literal">“engine”</code> property</h3>
<pre class="programlisting">  “engine”                   <a class="link" href="GdaReportEngine.html" title="GdaReportEngine"><span class="type">GdaReportEngine</span></a> *</pre>
<p>Owner: GdaReportDocument</p>
<p>Flags: Read / Write</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaReportDocument--template"></a><h3>The <code class="literal">“template”</code> property</h3>
<pre class="programlisting">  “template”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Owner: GdaReportDocument</p>
<p>Flags: Write</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>